Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: API description with openapi + scalar #32

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: API description with openapi + scalar #32

wants to merge 5 commits into from

Conversation

cmdoret
Copy link
Member

@cmdoret cmdoret commented Dec 16, 2024 •
edited
Loading

This PR uses apistos to generate openapi specs and render the documentation in scalar.

The docs are served at / when the server is running.

Breaking changes

Changed the API routes to be more explicit:

  • GET /list -> GET /collections
  • GET /top -> GET /codes/top

@cmdoret cmdoret linked an issue Dec 16, 2024 that may be closed by this pull request
[fuzon-http] OpenAPI spec integration #21
Open
@cmdoret cmdoret self-assigned this Dec 16, 2024
@cmdoret cmdoret added the documentation Improvements or additions to documentation label Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@cmdoret cmdoret

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[fuzon-http] OpenAPI spec integration
1 participant
@cmdoret